Docstrings supports more languages #190
Conversation
WalkthroughThe pull request updates the documentation for docstring generation in the Changes
Possibly related PRs
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Deploying coderabbit-docs with
|
| Latest commit: |
f6ef7c0
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b78b3e8e.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://howon-docstrings-langs.coderabbit-docs.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/finishing-touches/docstrings.md (2)
68-68: Fix PHP capitalization"Php" should be written as "PHP" to match the standard capitalization of the language name.
-- [x] Php ++ [x] PHP
80-80: Improve clarity and professionalism of the noteThe current note uses informal language and could be more specific about supported cases.
Consider this revision:
-In the case of JavaScript and TypeScript and the React versions of both, there are tons of ways to declare functions. At the moment, we only support the keyword `function` at the top level. +For JavaScript, TypeScript, and their React versions, function declarations can be written in multiple ways. Currently, only top-level functions declared using the `function` keyword are supported.🧰 Tools
🪛 LanguageTool
[style] ~80-~80: For conciseness, consider replacing this expression with an adverb.
Context: ... are tons of ways to declare functions. At the moment, we only support the keywordfunction...(AT_THE_MOMENT)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/finishing-touches/docstrings.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/finishing-touches/docstrings.md
[uncategorized] ~77-~77: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ... that the docstrings feature is in beta. :::note In the case of JavaScri...
(HYPHENATED_LY_ADVERB_ADJECTIVE)
[style] ~80-~80: For conciseness, consider replacing this expression with an adverb.
Context: ... are tons of ways to declare functions. At the moment, we only support the keyword function...
(AT_THE_MOMENT)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (1)
docs/finishing-touches/docstrings.md (1)
70-70: Consider clarifying React TypeScript listingReact TypeScript is listed separately from TypeScript. Consider adding a note to clarify the distinction between these entries, or combine them if they share the same docstring generation capabilities.
Also applies to: 75-75
I landed a buncha more languages in the prompting in the private production repo, so that has to entail this change.